get /cloud/aws/regions/{regionId}/instances
List AWS instances (getAwsRegionInstances)
Lists the AWS instances.
Path parameters
regionId (required)
Query Parameter — AWS region
Consumes
This API call consumes the following media types via the Content-Type request header:
- application/json
Request body
filterAWsResourcesFiler (required)
Body Parameter — AWS resources filter
Query parameters
credentialsName (required)
Query Parameter — Cloud credentials name
Return type
array[AwsInstanceInfo]
|
errorDetails (optional) |
StringToObjectMap |
|
id (optional) |
String Cloud VM ID |
|
powerState (optional) |
String |
|
privateIpAddress (optional) |
String Cloud VM physical IP address |
|
subnetId (optional) |
String Cloud VM subnet ID |
|
instanceType(optional) |
InstanceType |
| _type | String
Enum: AwsInstanceInfo |
|
tenancyType (optional) |
String |
|
isSpot (optional) |
Boolean AWS instance spot or not |
|
securityGroups (optional) |
Array AWS instance security groups |
|
publicIpAddress (optional) |
String AWS instance public IP address |
|
privateDnsName (optional) |
String AWS instance private DNS name |
|
state (optional) |
InstanceState |
|
networkInterfaces (optional) |
Array AWS instance network interfaces |
|
volumes (optional) |
String Attached EBS volumes |
|
tags (optional) |
String AWS instance tags |
|
status (optional) |
InstanceStatus |
|
availabilityZone (optional) |
String AWS instance Availability Zone |
|
launchTime (optional) |
Date AWS instance launch date and time format: date-time |
|
platform (optional) |
String AWS instance platform, for example, Windows |
|
stateChangeReason (optional) |
String AWS instance reason for state change, for example, spot instance termination |
Example data
Content-Type: application/json
[
{
"errorDetails": {
"_type": "StringToObjectMap",
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"id": "i-0019a59ec16fab0e1",
"powerState": "Starting",
"privateIpAddress": "12.34.56.78",
"subnetId": "subnet-1234657",
"tags": [
{
"key": "Owner",
"value": "Velostrata"
}
],
"instanceType": {
"cpus": 1,
"maxDataDiskCount": 1,
"memory": 1,
"name": "t2.micro",
"resourceDiskSize": 0
},
"_type": "AwsInstanceInfo",
"tenancyType": "Default",
"isSpot": true,
"securityGroups": [
{
"id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/Velostrata-datacenter-123465789-1234-9876/providers/Microsoft.Network/networkSecurityGroups/SG-12345abc",
"name": "SG-12345abc",
"location": "eastus",
"tags": [
{
"key": "Owner",
"value": "Velostrata"
}
]
}
],
"publicIpAddress": "12.34.56.78",
"privateDnsName": "machine.com",
"state": "Pending",
"networkInterfaces": [
{
"elasticIp": "12.34.56.78",
"id": "eni-123456",
"description": "eni-description"
}
],
"volumes": [
{
"id": "vol-123456",
"deviceName": "/dev/sda",
"size": 20,
"storageType": "standard",
"encrypted": true,
"kmsKey": "standard"
}
],
"status": {
"systemStatus": {
"status": "ok",
"details": [
{
"name": "reachability",
"status": "impaired",
"impairedSince": "2018-03-27T20:41:40.254Z"
}
]
},
"instanceStatus": {
"status": "ok",
"details": [
{
"name": "reachability",
"status": "impaired",
"impairedSince": "2018-03-27T20:41:40.254Z"
}
}
},
"availabilityZone": "eu-west-1c",
"launchTime": "2018-03-27T20:41:40.254Z",
"platform": "Windows",
"stateChangeReason": "Server.SpotInstanceTermination"
}
]
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
- application/json
Responses
200
OK
Default
Error ErrorInfo
|
errorCode (optional) |
String |
|
url(optional) |
String |
|
message (optional) |
String |